AdminMessageOrBuilder

interface AdminMessageOrBuilder : MessageOrBuilder

Inheritors

Properties

Functions

Link copied to clipboard

Add a contact (User) to the nodedb
.meshtastic.SharedContact add_contact = 66;
Link copied to clipboard

Add a contact (User) to the nodedb
.meshtastic.SharedContact add_contact = 66;
Link copied to clipboard

Backup the node's preferences
.meshtastic.AdminMessage.BackupLocation backup_preferences = 24;
Link copied to clipboard

Backup the node's preferences
.meshtastic.AdminMessage.BackupLocation backup_preferences = 24;
Link copied to clipboard

Begins an edit transaction for config, module config, owner, and channel settings changes
This will delay the standard *implicit* save to the file system and subsequent reboot behavior until committed (commit_edit_settings)
bool begin_edit_settings = 64;
Link copied to clipboard

Commits an open transaction for any edits made to config, module config, owner, and channel settings
bool commit_edit_settings = 65;
Link copied to clipboard

Delete the file by the specified path from the device
string delete_file_request = 22;
Link copied to clipboard
abstract fun getDeleteFileRequestBytes(): ByteString

Delete the file by the specified path from the device
string delete_file_request = 22;
Link copied to clipboard

Enter (UF2) DFU mode
Only implemented on NRF52 currently
bool enter_dfu_mode_request = 21;
Link copied to clipboard
abstract fun getExitSimulator(): Boolean

This message is only supported for the simulator Portduino build.
If received the simulator will exit successfully.
bool exit_simulator = 96;
Link copied to clipboard
abstract fun getFactoryResetConfig(): Int

Tell the node to factory reset config; all device state and configuration will be returned to factory defaults; BLE bonds will be preserved.
int32 factory_reset_config = 99;
Link copied to clipboard
abstract fun getFactoryResetDevice(): Int

Tell the node to factory reset config everything; all device state and configuration will be returned to factory defaults and BLE bonds will be cleared.
int32 factory_reset_device = 94;
Link copied to clipboard

Get the Canned Message Module messages in the response to this message.
bool get_canned_message_module_messages_request = 10;

Get the Canned Message Module messages in the response to this message.
string get_canned_message_module_messages_response = 11;

Get the Canned Message Module messages in the response to this message.
string get_canned_message_module_messages_response = 11;
Link copied to clipboard
abstract fun getGetChannelRequest(): Int

Send the specified channel in the response to this message
NOTE: This field is sent with the channel index + 1 (to ensure we never try to send 'zero' - which protobufs treats as not present)
uint32 get_channel_request = 1;
Link copied to clipboard

TODO: REPLACE
.meshtastic.Channel get_channel_response = 2;
Link copied to clipboard

TODO: REPLACE
.meshtastic.Channel get_channel_response = 2;
Link copied to clipboard

Ask for the following config data to be sent
.meshtastic.AdminMessage.ConfigType get_config_request = 5;
Link copied to clipboard

Ask for the following config data to be sent
.meshtastic.AdminMessage.ConfigType get_config_request = 5;
Link copied to clipboard

Send the current Config in the response to this message.
.meshtastic.Config get_config_response = 6;
Link copied to clipboard

Send the current Config in the response to this message.
.meshtastic.Config get_config_response = 6;
Link copied to clipboard

Request the node to send it's connection status
bool get_device_connection_status_request = 16;
Link copied to clipboard

Device connection status response
.meshtastic.DeviceConnectionStatus get_device_connection_status_response = 17;

Device connection status response
.meshtastic.DeviceConnectionStatus get_device_connection_status_response = 17;
Link copied to clipboard

Request the node to send device metadata (firmware, protobuf version, etc)
bool get_device_metadata_request = 12;
Link copied to clipboard

Device metadata response
.meshtastic.DeviceMetadata get_device_metadata_response = 13;
Link copied to clipboard

Device metadata response
.meshtastic.DeviceMetadata get_device_metadata_response = 13;
Link copied to clipboard

Ask for the following config data to be sent
.meshtastic.AdminMessage.ModuleConfigType get_module_config_request = 7;
Link copied to clipboard

Ask for the following config data to be sent
.meshtastic.AdminMessage.ModuleConfigType get_module_config_request = 7;
Link copied to clipboard

Send the current Config in the response to this message.
.meshtastic.ModuleConfig get_module_config_response = 8;
Link copied to clipboard

Send the current Config in the response to this message.
.meshtastic.ModuleConfig get_module_config_response = 8;
Link copied to clipboard

Get the mesh's nodes with their available gpio pins for RemoteHardware module use
bool get_node_remote_hardware_pins_request = 19;
Link copied to clipboard

Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use
.meshtastic.NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20;

Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use
.meshtastic.NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20;
Link copied to clipboard
abstract fun getGetOwnerRequest(): Boolean

Send the current owner data in the response to this message.
bool get_owner_request = 3;
Link copied to clipboard

TODO: REPLACE
.meshtastic.User get_owner_response = 4;
Link copied to clipboard

TODO: REPLACE
.meshtastic.User get_owner_response = 4;
Link copied to clipboard

Get the Ringtone in the response to this message.
bool get_ringtone_request = 14;
Link copied to clipboard

Get the Ringtone in the response to this message.
string get_ringtone_response = 15;
Link copied to clipboard
abstract fun getGetRingtoneResponseBytes(): ByteString

Get the Ringtone in the response to this message.
string get_ringtone_response = 15;
Link copied to clipboard

Tell the node to send the stored ui data.
bool get_ui_config_request = 44;
Link copied to clipboard

Reply stored device ui data.
.meshtastic.DeviceUIConfig get_ui_config_response = 45;
Link copied to clipboard

Reply stored device ui data.
.meshtastic.DeviceUIConfig get_ui_config_response = 45;
Link copied to clipboard

Initiate or respond to a key verification request
.meshtastic.KeyVerificationAdmin key_verification = 67;
Link copied to clipboard

Initiate or respond to a key verification request
.meshtastic.KeyVerificationAdmin key_verification = 67;
Link copied to clipboard
abstract fun getNodedbReset(): Int

Tell the node to reset the nodedb.
int32 nodedb_reset = 100;
Link copied to clipboard
abstract fun getRebootOtaSeconds(): Int

Tell the node to reboot into the OTA Firmware in this many seconds (or <0 to cancel reboot)
Only Implemented for ESP32 Devices. This needs to be issued to send a new main firmware via bluetooth.
int32 reboot_ota_seconds = 95;
Link copied to clipboard
abstract fun getRebootSeconds(): Int

Tell the node to reboot in this many seconds (or <0 to cancel reboot)
int32 reboot_seconds = 97;
Link copied to clipboard

Remove backups of the node's preferences
.meshtastic.AdminMessage.BackupLocation remove_backup_preferences = 26;
Link copied to clipboard

Remove backups of the node's preferences
.meshtastic.AdminMessage.BackupLocation remove_backup_preferences = 26;
Link copied to clipboard
abstract fun getRemoveByNodenum(): Int

Remove the node by the specified node-num from the NodeDB on the device
uint32 remove_by_nodenum = 38;
Link copied to clipboard
abstract fun getRemoveFavoriteNode(): Int

Set specified node-num to be un-favorited on the NodeDB on the device
uint32 remove_favorite_node = 40;
Link copied to clipboard

Clear fixed position coordinates and then set position.fixed_position = false
bool remove_fixed_position = 42;
Link copied to clipboard
abstract fun getRemoveIgnoredNode(): Int

Set specified node-num to be un-ignored on the NodeDB on the device
uint32 remove_ignored_node = 48;
Link copied to clipboard

Restore the node's preferences
.meshtastic.AdminMessage.BackupLocation restore_preferences = 25;
Link copied to clipboard

Restore the node's preferences
.meshtastic.AdminMessage.BackupLocation restore_preferences = 25;
Link copied to clipboard

Send an input event to the node.
This is used to trigger physical input events like button presses, touch events, etc.
.meshtastic.AdminMessage.InputEvent send_input_event = 27;
Link copied to clipboard

Send an input event to the node.
This is used to trigger physical input events like button presses, touch events, etc.
.meshtastic.AdminMessage.InputEvent send_input_event = 27;
Link copied to clipboard
abstract fun getSessionPasskey(): ByteString

The node generates this key and sends it with any get_x_response packets.
The client MUST include the same key with any set_x commands. Key expires after 300 seconds.
Prevents replay attacks for admin messages.
bytes session_passkey = 101;
Link copied to clipboard

Set the Canned Message Module messages text.
string set_canned_message_module_messages = 36;
Link copied to clipboard
abstract fun getSetCannedMessageModuleMessagesBytes(): ByteString

Set the Canned Message Module messages text.
string set_canned_message_module_messages = 36;
Link copied to clipboard

Set channels (using the new API).
A special channel is the "primary channel".
The other records are secondary channels.
Note: only one channel can be marked as primary.
If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.
.meshtastic.Channel set_channel = 33;
Link copied to clipboard

Set channels (using the new API).
A special channel is the "primary channel".
The other records are secondary channels.
Note: only one channel can be marked as primary.
If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.
.meshtastic.Channel set_channel = 33;
Link copied to clipboard

Set the current Config
.meshtastic.Config set_config = 34;
Link copied to clipboard

Set the current Config
.meshtastic.Config set_config = 34;
Link copied to clipboard
abstract fun getSetFavoriteNode(): Int

Set specified node-num to be favorited on the NodeDB on the device
uint32 set_favorite_node = 39;
Link copied to clipboard

Set fixed position data on the node and then set the position.fixed_position = true
.meshtastic.Position set_fixed_position = 41;
Link copied to clipboard

Set fixed position data on the node and then set the position.fixed_position = true
.meshtastic.Position set_fixed_position = 41;
Link copied to clipboard

Setup a node for licensed amateur (ham) radio operation
.meshtastic.HamParameters set_ham_mode = 18;
Link copied to clipboard

Setup a node for licensed amateur (ham) radio operation
.meshtastic.HamParameters set_ham_mode = 18;
Link copied to clipboard
abstract fun getSetIgnoredNode(): Int

Set specified node-num to be ignored on the NodeDB on the device
uint32 set_ignored_node = 47;
Link copied to clipboard

Set the current Config
.meshtastic.ModuleConfig set_module_config = 35;
Link copied to clipboard

Set the current Config
.meshtastic.ModuleConfig set_module_config = 35;
Link copied to clipboard

Set the owner for this node
.meshtastic.User set_owner = 32;
Link copied to clipboard

Set the owner for this node
.meshtastic.User set_owner = 32;
Link copied to clipboard

Set the ringtone for ExternalNotification.
string set_ringtone_message = 37;
Link copied to clipboard
abstract fun getSetRingtoneMessageBytes(): ByteString

Set the ringtone for ExternalNotification.
string set_ringtone_message = 37;
Link copied to clipboard
abstract fun getSetScale(): Int

Set zero and offset for scale chips
uint32 set_scale = 23;
Link copied to clipboard
abstract fun getSetTimeOnly(): Int

Set time only on the node
Convenience method to set the time on the node (as Net quality) without any other position data
fixed32 set_time_only = 43;
Link copied to clipboard
abstract fun getShutdownSeconds(): Int

Tell the node to shutdown in this many seconds (or <0 to cancel shutdown)
int32 shutdown_seconds = 98;
Link copied to clipboard

Tell the node to store UI data persistently.
.meshtastic.DeviceUIConfig store_ui_config = 46;
Link copied to clipboard

Tell the node to store UI data persistently.
.meshtastic.DeviceUIConfig store_ui_config = 46;
Link copied to clipboard
abstract fun hasAddContact(): Boolean

Add a contact (User) to the nodedb
.meshtastic.SharedContact add_contact = 66;
Link copied to clipboard

Backup the node's preferences
.meshtastic.AdminMessage.BackupLocation backup_preferences = 24;
Link copied to clipboard

Begins an edit transaction for config, module config, owner, and channel settings changes
This will delay the standard *implicit* save to the file system and subsequent reboot behavior until committed (commit_edit_settings)
bool begin_edit_settings = 64;
Link copied to clipboard

Commits an open transaction for any edits made to config, module config, owner, and channel settings
bool commit_edit_settings = 65;
Link copied to clipboard

Delete the file by the specified path from the device
string delete_file_request = 22;
Link copied to clipboard

Enter (UF2) DFU mode
Only implemented on NRF52 currently
bool enter_dfu_mode_request = 21;
Link copied to clipboard
abstract fun hasExitSimulator(): Boolean

This message is only supported for the simulator Portduino build.
If received the simulator will exit successfully.
bool exit_simulator = 96;
Link copied to clipboard

Tell the node to factory reset config; all device state and configuration will be returned to factory defaults; BLE bonds will be preserved.
int32 factory_reset_config = 99;
Link copied to clipboard

Tell the node to factory reset config everything; all device state and configuration will be returned to factory defaults and BLE bonds will be cleared.
int32 factory_reset_device = 94;
Link copied to clipboard

Get the Canned Message Module messages in the response to this message.
bool get_canned_message_module_messages_request = 10;

Get the Canned Message Module messages in the response to this message.
string get_canned_message_module_messages_response = 11;
Link copied to clipboard

Send the specified channel in the response to this message
NOTE: This field is sent with the channel index + 1 (to ensure we never try to send 'zero' - which protobufs treats as not present)
uint32 get_channel_request = 1;
Link copied to clipboard

TODO: REPLACE
.meshtastic.Channel get_channel_response = 2;
Link copied to clipboard

Ask for the following config data to be sent
.meshtastic.AdminMessage.ConfigType get_config_request = 5;
Link copied to clipboard

Send the current Config in the response to this message.
.meshtastic.Config get_config_response = 6;
Link copied to clipboard

Request the node to send it's connection status
bool get_device_connection_status_request = 16;
Link copied to clipboard

Device connection status response
.meshtastic.DeviceConnectionStatus get_device_connection_status_response = 17;
Link copied to clipboard

Request the node to send device metadata (firmware, protobuf version, etc)
bool get_device_metadata_request = 12;
Link copied to clipboard

Device metadata response
.meshtastic.DeviceMetadata get_device_metadata_response = 13;
Link copied to clipboard

Ask for the following config data to be sent
.meshtastic.AdminMessage.ModuleConfigType get_module_config_request = 7;
Link copied to clipboard

Send the current Config in the response to this message.
.meshtastic.ModuleConfig get_module_config_response = 8;
Link copied to clipboard

Get the mesh's nodes with their available gpio pins for RemoteHardware module use
bool get_node_remote_hardware_pins_request = 19;
Link copied to clipboard

Respond with the mesh's nodes with their available gpio pins for RemoteHardware module use
.meshtastic.NodeRemoteHardwarePinsResponse get_node_remote_hardware_pins_response = 20;
Link copied to clipboard
abstract fun hasGetOwnerRequest(): Boolean

Send the current owner data in the response to this message.
bool get_owner_request = 3;
Link copied to clipboard

TODO: REPLACE
.meshtastic.User get_owner_response = 4;
Link copied to clipboard

Get the Ringtone in the response to this message.
bool get_ringtone_request = 14;
Link copied to clipboard

Get the Ringtone in the response to this message.
string get_ringtone_response = 15;
Link copied to clipboard

Tell the node to send the stored ui data.
bool get_ui_config_request = 44;
Link copied to clipboard

Reply stored device ui data.
.meshtastic.DeviceUIConfig get_ui_config_response = 45;
Link copied to clipboard
abstract fun hasKeyVerification(): Boolean

Initiate or respond to a key verification request
.meshtastic.KeyVerificationAdmin key_verification = 67;
Link copied to clipboard
abstract fun hasNodedbReset(): Boolean

Tell the node to reset the nodedb.
int32 nodedb_reset = 100;
Link copied to clipboard

Tell the node to reboot into the OTA Firmware in this many seconds (or <0 to cancel reboot)
Only Implemented for ESP32 Devices. This needs to be issued to send a new main firmware via bluetooth.
int32 reboot_ota_seconds = 95;
Link copied to clipboard
abstract fun hasRebootSeconds(): Boolean

Tell the node to reboot in this many seconds (or <0 to cancel reboot)
int32 reboot_seconds = 97;
Link copied to clipboard

Remove backups of the node's preferences
.meshtastic.AdminMessage.BackupLocation remove_backup_preferences = 26;
Link copied to clipboard
abstract fun hasRemoveByNodenum(): Boolean

Remove the node by the specified node-num from the NodeDB on the device
uint32 remove_by_nodenum = 38;
Link copied to clipboard

Set specified node-num to be un-favorited on the NodeDB on the device
uint32 remove_favorite_node = 40;
Link copied to clipboard

Clear fixed position coordinates and then set position.fixed_position = false
bool remove_fixed_position = 42;
Link copied to clipboard

Set specified node-num to be un-ignored on the NodeDB on the device
uint32 remove_ignored_node = 48;
Link copied to clipboard

Restore the node's preferences
.meshtastic.AdminMessage.BackupLocation restore_preferences = 25;
Link copied to clipboard
abstract fun hasSendInputEvent(): Boolean

Send an input event to the node.
This is used to trigger physical input events like button presses, touch events, etc.
.meshtastic.AdminMessage.InputEvent send_input_event = 27;
Link copied to clipboard

Set the Canned Message Module messages text.
string set_canned_message_module_messages = 36;
Link copied to clipboard
abstract fun hasSetChannel(): Boolean

Set channels (using the new API).
A special channel is the "primary channel".
The other records are secondary channels.
Note: only one channel can be marked as primary.
If the client sets a particular channel to be primary, the previous channel will be set to SECONDARY automatically.
.meshtastic.Channel set_channel = 33;
Link copied to clipboard
abstract fun hasSetConfig(): Boolean

Set the current Config
.meshtastic.Config set_config = 34;
Link copied to clipboard
abstract fun hasSetFavoriteNode(): Boolean

Set specified node-num to be favorited on the NodeDB on the device
uint32 set_favorite_node = 39;
Link copied to clipboard

Set fixed position data on the node and then set the position.fixed_position = true
.meshtastic.Position set_fixed_position = 41;
Link copied to clipboard
abstract fun hasSetHamMode(): Boolean

Setup a node for licensed amateur (ham) radio operation
.meshtastic.HamParameters set_ham_mode = 18;
Link copied to clipboard
abstract fun hasSetIgnoredNode(): Boolean

Set specified node-num to be ignored on the NodeDB on the device
uint32 set_ignored_node = 47;
Link copied to clipboard
abstract fun hasSetModuleConfig(): Boolean

Set the current Config
.meshtastic.ModuleConfig set_module_config = 35;
Link copied to clipboard
abstract fun hasSetOwner(): Boolean

Set the owner for this node
.meshtastic.User set_owner = 32;
Link copied to clipboard

Set the ringtone for ExternalNotification.
string set_ringtone_message = 37;
Link copied to clipboard
abstract fun hasSetScale(): Boolean

Set zero and offset for scale chips
uint32 set_scale = 23;
Link copied to clipboard
abstract fun hasSetTimeOnly(): Boolean

Set time only on the node
Convenience method to set the time on the node (as Net quality) without any other position data
fixed32 set_time_only = 43;
Link copied to clipboard
abstract fun hasShutdownSeconds(): Boolean

Tell the node to shutdown in this many seconds (or <0 to cancel shutdown)
int32 shutdown_seconds = 98;
Link copied to clipboard
abstract fun hasStoreUiConfig(): Boolean

Tell the node to store UI data persistently.
.meshtastic.DeviceUIConfig store_ui_config = 46;